/*
 * Copyright (c) 2010, Nikolaus Moll
 * All rights reserved.
 */
package net.miblounge.gradecalculator.importplugin.interfaces;

import java.util.List;

import net.miblounge.gradecalculator.importplugin.data.ImportedExaminationResult;

public interface ICommonImportPlugin {
	/**
	 * Returns the plug-in's name shown in the application menu
	 * @return name of plug-in
	 */
	String getName();
	
	/**
	 * Returns the version information of the plug-in
	 * @return version information
	 */
	String getVersion();
	
	/**
	 * Returns the status line text which is shown when the plug-in is hovered
	 * @return status line text
	 */
	String getStatusLineText();

	/**
	 * Returns the list of examination results
	 * @return list of results
	 */
	List<ImportedExaminationResult> getResults();
	
	/**
	 * Returns the name of the university
	 * @return university's name
	 */
	String getUniversity();
	
	/**
	 * Returns the aimed degree of studies
	 * @return name of degree, e.g. 'Bachelor', 'Master'
	 */
	String getDegree();

	/**
	 * Returns name of the course of studies
	 * @return name
	 */
	String getCourseOfScience();

	/**
	 * Returns the semester of the student's examination regulations
	 * The semester should not have any spaces or special characters, and should contain
	 * the beginning year only
	 * @return semester name, e.g. 'SS2008', 'WS2010'
	 */
	String getSemester();
	
	/**
	 * Returns the name of the student
	 * @return student's name
	 */
	String getStudent();

	/**
	 * Returns a list of the selected module lists (focus) by the student
	 * @return list of modules
	 */
	List<String> getSelectedModuleLists();

}
